<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>console</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/console/">console</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;console
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="console-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package console</h1><p class="nomargin-top"><span class="codelink"><a href="console-pysrc.html">source&nbsp;code</a></span></p>
<h1 class="heading">Overview</h1>
    <p>The console framework allows for the rapid development of 
    interactive console based applications in Python in the style of the 
    Python shell. Software developers often want to create lightweight 
    programs using the terminal or the shell to control minor or partial 
    functionality in a large application. Instead of writing a completly 
    scritped executable .py file, the console framework allows for the 
    rapid integration of specific commands into a customizable interactive 
    shell.</p>
    <p>At its most basic, the framework allows you to create <a 
    href="console.interactive.InteractiveCommand-class.html" 
    class="link">InteractiveCommand</a>s to be added to an <a 
    href="console.interactive.InteractiveShell-class.html" 
    class="link">InteractiveShell</a>. These commands have name, 
    description, and help text associated with them, and allow you to add 
    specific functionality, which returns output via stdout. <a 
    href="console.interactive.InteractiveShell-class.html" 
    class="link">InteractiveShell</a> allows you to customize a banner and 
    a prompt, and can be easily created and instantiated with commands in a
    <code>__main__</code> method.</p>
  <h1 class="heading">Tutorial</h1>
    <p>See <a href="console.interactive-module.html" 
    class="link">interactive</a> for specifics about extending <a 
    href="console.interactive.InteractiveCommand-class.html" 
    class="link">InteractiveCommand</a> and instantiating and running <a 
    href="console.interactive.InteractiveShell-class.html" 
    class="link">InteractiveShell</a>. See <a 
    href="console.example-module.html" class="link">example</a> for a 
    working example of a console program.</p>
  <h1 class="heading">Package Organization</h1>
    <p>The console source code contains the following subpackages and 
    modules:</p>
    <p></p>
<center><table border="0" cellpadding="0" cellspacing="0" class="graph">
  <tr><td align="center">
  <map id="package_tree_for_console" name="package_tree_for_console">
<area shape="rect" href="console.example-module.html" title="console.example" alt="" coords="25,55,84,76"/>
<area shape="rect" href="console.interactive-module.html" title="console.interactive" alt="" coords="92,55,159,76"/>
<area shape="rect" href="console-module.html" title="console" alt="" coords="16,21,168,85"/>
<area shape="rect" href="console-module.html" title="console" alt="" coords="16,11,168,85"/>
</map>
  <img src="package_tree_for_console.gif" alt='Package Tree for console' usemap="#package_tree_for_console" ismap="ismap" class="graph-with-title" />
  </td></tr>
  <tr><td align='center'>
<span class="graph-title">Package Tree for console</span>
  </td></tr>
</table><br /></center>    <p></p>
    <p><a href="console.interactive-module.html" 
    class="link">interactive</a> is the entry point to the console 
    framework. This module allows you to create <a 
    href="console.interactive.InteractiveCommand-class.html" 
    class="link">InteractiveCommand</a>s and an <a 
    href="console.interactive.CustomCompleter-class.html" 
    class="link">CustomCompleter</a> to be added to an <a 
    href="console.interactive.InteractiveShell-class.html" 
    class="link">InteractiveShell</a>.</p>
    <p><a href="console.example-module.html" class="link">example</a> 
    contains a sample program for reference.</p>

<hr />
<div class="fields">      <p><strong>Author:</strong>
        <a href="mailto:peacmen@tacnetsol.com" target="_top">Peter 
        Eacmen</a>
      </p>
      <p><strong>Organization:</strong>
        Tactical Network Solutions
      </p>
      <p><strong>License:</strong>
        Open Source MIT License
      </p>
      <p><strong>Copyright:</strong>
        &copy; 2010 Tactical Network Solutions
      </p>
      <p><strong>Requires:</strong>
        Python 2.6
      </p>
      <p><strong>Version:</strong>
        1.0
      </p>
      <p><strong>Change Log:</strong>
        <i>__init__.py 2 2010-11-29 13:48:00 -0400 bbengfort</i>
      </p>
      <p><strong>Since:</strong>
        2010-11-29 17:20:39 -0400
      </p>
      <dl><dt>See Also:</dt>
        <dd>
          <a href="http://tacnetsol.com" target="_top">The Tactical Network
          Solutions homepage</a>,
          <a href="http://code.google.com/p/console/" target="_top">Google 
          Code Project</a>,
          <a href="http://code.google.com/p/console/wiki/console" 
          target="_top">The console Wiki</a>
        </dd>
      </dl>
      <strong>To Do:</strong>
      <ul class="nomargin-top">
        <li>
        Create console Wiki page
        </li>
        <li>
        Create consoel Google Code Project
        </li>
        <li>
        Create documentation config file
        </li>
        <li>
        Create examples
        </li>
        <li>
        Create console-program examples
        </li>
        <li>
        Create customized icon
        </li>
        <li>
        Re-add colorization
        </li>
        <li>
        Add ASCII tables
        </li>
      </ul>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Submodules</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Submodules"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr><td class="summary">
  <ul class="nomargin">
    <li> <strong class="uidlink"><a href="console.example-module.html">console.example</a></strong>: <em class="summary">Example of using the console framework.</em>    </li>
    <li> <strong class="uidlink"><a href="console.interactive-module.html">console.interactive</a></strong>: <em class="summary">Framework for creating command line programs with an interactive 
        prompt.</em>    </li>
  </ul></td></tr>
</table>

<br />
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>str</code></span>
    </td><td class="summary">
        <a name="__version__"></a><span class="summary-name">__version__</span> = <code title="&quot;1.0&quot;">&quot;1.0&quot;</code><br />
      The version of console - major.minor revision numbering
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>list</code></span>
    </td><td class="summary">
        <a name="__authors__"></a><span class="summary-name">__authors__</span> = <code title="[&quot;Peter Eacmen &lt;peacmen@tacnetsol.com&quot;,]">[&quot;Peter Eacmen &lt;peacmen@tacnetsol.com&quot;,]</code><br />
      The primary authors of console
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>str</code></span>
    </td><td class="summary">
        <a name="__url__"></a><span class="summary-name">__url__</span> = <code title="'http://code.google.com/p/console/'">'http://code.google.com/p/console/'</code><br />
      The URL for the console homepage, hosted on Google Code
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>str</code></span>
    </td><td class="summary">
        <a name="__license__"></a><span class="summary-name">__license__</span> = <code title="&quot;Open Source MIT&quot;">&quot;Open Source MIT&quot;</code><br />
      The license governing the use and distribution of console
    </td>
  </tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/console/">console</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Tue Nov 30 11:33:30 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
